Skip to content

CCM-10077 Relax api contact details validation#940

Merged
Ian-Hodges merged 19 commits into
releasefrom
feature/CCM-10077_relax-api-validation
May 30, 2025
Merged

CCM-10077 Relax api contact details validation#940
Ian-Hodges merged 19 commits into
releasefrom
feature/CCM-10077_relax-api-validation

Conversation

@Ian-Hodges
Copy link
Copy Markdown
Contributor

@Ian-Hodges Ian-Hodges commented May 20, 2025

Summary

Currently the NHS Notify batch send API performs up-front validation of fields in the request payload. Any validation errors cause the entire message request (for the send single message API) or the entire batch (for the send batch API and MESH) to be rejected. The original intention was to fail the request quickly for "client issues" that are within the control of the integrator. However, an unintended consequence of this is that message requests that have a validation error pertaining to a single channel (e.g. a malformed postcode override) would be rejected but may have succeeded via a different channel in the routing plan had the request been accepted. Furthermore, for batch requests a single validation error causes the entire batch to be rejected. Finally, the existing behaviour where an invalid overridden contact detail causes the message request to be rejected differs from the behaviour when contact details are retrieved from PDS as in this case validation occurs during enrichment, after the request has already been accepted.

Test Evidence

Test evidence added to CCM-10077

Reviews Required

  • Dev
  • Test
  • Tech Author
  • Product Owner

Checklist

  • Brief description of work completed, and any technical decisions made as part of the PR
  • PR link added as a comment to the relevant JIRA ticket
  • PR link shared on Slack and/or Teams
  • 2 reviews received
  • Tester approval

@github-actions
Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-10077

@Ian-Hodges Ian-Hodges force-pushed the feature/CCM-10077_relax-api-validation branch from 5e70e12 to fe85ade Compare May 20, 2025 13:44
@Ian-Hodges Ian-Hodges changed the title Feature/ccm 10077 relax api validation CCM-10077 Relax api contact details validation May 21, 2025
@Ian-Hodges Ian-Hodges marked this pull request as ready for review May 21, 2025 11:47
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 21, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 21, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 21, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 21, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 21, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 21, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 27, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 27, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 28, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 28, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 28, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 28, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 28, 2025
@NHSDigital NHSDigital deleted a comment from github-actions Bot May 28, 2025
@Ian-Hodges Ian-Hodges merged commit 02c1f9e into release May 30, 2025
5 of 6 checks passed
@Ian-Hodges Ian-Hodges deleted the feature/CCM-10077_relax-api-validation branch May 30, 2025 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants